<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>cbp2make: CWorkspaceUnit Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">cbp2make
   </div>
   <div id="projectbrief">Makefile generation tool for Code::Blocks IDE</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="../../index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="../../pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="../../namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="../../annotated.html"><span>Classes</span></a></li>
      <li><a href="../../files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="../../search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="../../annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="../../hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="../../functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="../../d6/da9/classCWorkspaceUnit-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">CWorkspaceUnit Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Workspace unit description.  
 <a href="../../da/d0a/classCWorkspaceUnit.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="../../d0/d86/cbworkspace_8h_source.html">cbworkspace.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a686ef0c6dfac33827cc6b971e78b8cbd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d0a/classCWorkspaceUnit.html#a686ef0c6dfac33827cc6b971e78b8cbd">Clear</a> (void)</td></tr>
<tr class="memdesc:a686ef0c6dfac33827cc6b971e78b8cbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the workspace unit to the initial state.  <a href="#a686ef0c6dfac33827cc6b971e78b8cbd">More...</a><br/></td></tr>
<tr class="separator:a686ef0c6dfac33827cc6b971e78b8cbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e379f9772bdac8445b950a105687a6b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d0a/classCWorkspaceUnit.html#a3e379f9772bdac8445b950a105687a6b">Read</a> (const TiXmlElement *UnitRoot)</td></tr>
<tr class="memdesc:a3e379f9772bdac8445b950a105687a6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the workspace unit settings from an XML document.  <a href="#a3e379f9772bdac8445b950a105687a6b">More...</a><br/></td></tr>
<tr class="separator:a3e379f9772bdac8445b950a105687a6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06d7939e505f8b9200474b6da03339c6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d0a/classCWorkspaceUnit.html#a06d7939e505f8b9200474b6da03339c6">Show</a> (void)</td></tr>
<tr class="memdesc:a06d7939e505f8b9200474b6da03339c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints the workspace unit contents to standard output.  <a href="#a06d7939e505f8b9200474b6da03339c6">More...</a><br/></td></tr>
<tr class="separator:a06d7939e505f8b9200474b6da03339c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a497ddf121815312350dda067c2072595"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d0a/classCWorkspaceUnit.html#a497ddf121815312350dda067c2072595">LoadProject</a> (const <a class="el" href="../../d7/da9/classCString.html">CString</a> &amp;WorkspacePath)</td></tr>
<tr class="memdesc:a497ddf121815312350dda067c2072595"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads the workspace unit (project) from file.  <a href="#a497ddf121815312350dda067c2072595">More...</a><br/></td></tr>
<tr class="separator:a497ddf121815312350dda067c2072595"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43606fefd429de9e688d4ad8c459e2d7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d0a/classCWorkspaceUnit.html#a43606fefd429de9e688d4ad8c459e2d7">CWorkspaceUnit</a> (void)</td></tr>
<tr class="memdesc:a43606fefd429de9e688d4ad8c459e2d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates workspace unit.  <a href="#a43606fefd429de9e688d4ad8c459e2d7">More...</a><br/></td></tr>
<tr class="separator:a43606fefd429de9e688d4ad8c459e2d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a301fd79216253991e9207e9d167185aa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d0a/classCWorkspaceUnit.html#a301fd79216253991e9207e9d167185aa">~CWorkspaceUnit</a> (void)</td></tr>
<tr class="memdesc:a301fd79216253991e9207e9d167185aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys workspace unit.  <a href="#a301fd79216253991e9207e9d167185aa">More...</a><br/></td></tr>
<tr class="separator:a301fd79216253991e9207e9d167185aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a7e229a4a570c2ac60165969ad85e14c3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d7/da9/classCString.html">CString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d0a/classCWorkspaceUnit.html#a7e229a4a570c2ac60165969ad85e14c3">m_FileName</a></td></tr>
<tr class="memdesc:a7e229a4a570c2ac60165969ad85e14c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Workspace unit file name.  <a href="#a7e229a4a570c2ac60165969ad85e14c3">More...</a><br/></td></tr>
<tr class="separator:a7e229a4a570c2ac60165969ad85e14c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6984ed5bc47822d9d8cbc1bf82f19beb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../dc/daa/classCStringList.html">CStringList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d0a/classCWorkspaceUnit.html#a6984ed5bc47822d9d8cbc1bf82f19beb">m_Depends</a></td></tr>
<tr class="memdesc:a6984ed5bc47822d9d8cbc1bf82f19beb"><td class="mdescLeft">&#160;</td><td class="mdescRight">List of workspace unit dependencies.  <a href="#a6984ed5bc47822d9d8cbc1bf82f19beb">More...</a><br/></td></tr>
<tr class="separator:a6984ed5bc47822d9d8cbc1bf82f19beb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07129425366054f78a5416c09a028c26"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../da/d32/classCCodeBlocksProject.html">CCodeBlocksProject</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d0a/classCWorkspaceUnit.html#a07129425366054f78a5416c09a028c26">m_Project</a></td></tr>
<tr class="memdesc:a07129425366054f78a5416c09a028c26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains project properties.  <a href="#a07129425366054f78a5416c09a028c26">More...</a><br/></td></tr>
<tr class="separator:a07129425366054f78a5416c09a028c26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12fe48bb00386ea645fe3e7f699fd967"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d0a/classCWorkspaceUnit.html#a12fe48bb00386ea645fe3e7f699fd967">m_Weight</a></td></tr>
<tr class="memdesc:a12fe48bb00386ea645fe3e7f699fd967"><td class="mdescLeft">&#160;</td><td class="mdescRight">Weight (priority) of the workspace unit.  <a href="#a12fe48bb00386ea645fe3e7f699fd967">More...</a><br/></td></tr>
<tr class="separator:a12fe48bb00386ea645fe3e7f699fd967"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a202ad87f231d244c3c0c3537e01a269b"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d0a/classCWorkspaceUnit.html#a202ad87f231d244c3c0c3537e01a269b">CCodeBlocksWorkspace</a></td></tr>
<tr class="separator:a202ad87f231d244c3c0c3537e01a269b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67d24e5943ac4af577992f63a808c689"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d0a/classCWorkspaceUnit.html#a67d24e5943ac4af577992f63a808c689">CProjectWeightComparison</a></td></tr>
<tr class="separator:a67d24e5943ac4af577992f63a808c689"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Workspace unit description. </p>
<p>Contains properties of Code::Blocks workspace: subprojects, their dependencies and priorities. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a43606fefd429de9e688d4ad8c459e2d7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CWorkspaceUnit::CWorkspaceUnit </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname">)</td><td></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates workspace unit. </p>

</div>
</div>
<a class="anchor" id="a301fd79216253991e9207e9d167185aa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CWorkspaceUnit::~CWorkspaceUnit </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname">)</td><td></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destroys workspace unit. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a686ef0c6dfac33827cc6b971e78b8cbd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CWorkspaceUnit::Clear </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname">)</td><td></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Resets the workspace unit to the initial state. </p>

</div>
</div>
<a class="anchor" id="a497ddf121815312350dda067c2072595"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CWorkspaceUnit::LoadProject </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="../../d7/da9/classCString.html">CString</a> &amp;&#160;</td>
          <td class="paramname"><em>WorkspacePath</em>)</td><td></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Loads the workspace unit (project) from file. </p>
<dl class="section return"><dt>Returns</dt><dd><em>true</em> if the workspace unit was successfully loaded, <em>false</em> otherwise.</dd></dl>
<p>Uses CBuildProject::LoadProject(const CString&amp; FileName) with <a class="el" href="../../da/d0a/classCWorkspaceUnit.html#a7e229a4a570c2ac60165969ad85e14c3" title="Workspace unit file name. ">CWorkspaceUnit::m_FileName</a> as the workspace unit file name. </p>

</div>
</div>
<a class="anchor" id="a3e379f9772bdac8445b950a105687a6b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CWorkspaceUnit::Read </td>
          <td>(</td>
          <td class="paramtype">const TiXmlElement *&#160;</td>
          <td class="paramname"><em>UnitRoot</em>)</td><td></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reads the workspace unit settings from an XML document. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">UnitRoot</td><td>an element of XML document. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a06d7939e505f8b9200474b6da03339c6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CWorkspaceUnit::Show </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname">)</td><td></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Prints the workspace unit contents to standard output. </p>

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="a202ad87f231d244c3c0c3537e01a269b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="../../d8/d67/classCCodeBlocksWorkspace.html">CCodeBlocksWorkspace</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a67d24e5943ac4af577992f63a808c689"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="../../d4/d1d/classCProjectWeightComparison.html">CProjectWeightComparison</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a6984ed5bc47822d9d8cbc1bf82f19beb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">CWorkspaceUnit::m_Depends</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>List of workspace unit dependencies. </p>
<p>Contains list of other workspace unit (project) names that this workspace unit requires to be built before itself. </p>

</div>
</div>
<a class="anchor" id="a7e229a4a570c2ac60165969ad85e14c3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">CWorkspaceUnit::m_FileName</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Workspace unit file name. </p>

</div>
</div>
<a class="anchor" id="a07129425366054f78a5416c09a028c26"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">CWorkspaceUnit::m_Project</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Contains project properties. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="../../da/d32/classCCodeBlocksProject.html" title="Project description. ">CCodeBlocksProject</a>. </dd></dl>

</div>
</div>
<a class="anchor" id="a12fe48bb00386ea645fe3e7f699fd967"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">CWorkspaceUnit::m_Weight</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Weight (priority) of the workspace unit. </p>
<p>Normally workspace unit weights range from 0 to 100. Lower weight means higher priority and vice versa. Workspace units with lower weights are compiled and linked first. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="../../d0/d86/cbworkspace_8h_source.html">cbworkspace.h</a></li>
<li>src/<a class="el" href="../../d9/d5a/cbworkspace_8cpp.html">cbworkspace.cpp</a></li>
<li>src/doc/<a class="el" href="../../d3/d8b/cbworkspace_8dox.html">cbworkspace.dox</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Jun 9 2013 10:56:09 for cbp2make by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>
